Summary

Please summarize your changes, describing what they are and why they were made.

Changelog

Please write an accurate and concise changelog for your changes.

Relevant Issues

Please list any related issues (e.g. bug, task).

Type of Change

Please select any type below that is applicable to your changes, and delete those that are not.

• Breaking - any change that would cause existing functionality to not work as expected
• Chore - refactoring, build scripts or anything else that isn't user-facing
• Docs - changes to the documentation
• Fix - a change which fixes an issue
• New - a change which implements a new feature
• Update - a change which updates existing functionality

Testing

Platforms

Please select any platforms where your changes have been tested.

• Desktop
  • MacOS
  • Linux
  • Windows

Instructions

Please describe the specific instructions, configurations, and/or test cases necessary to test and verify that your changes work as intended.

Checklist

Please tick all of the following boxes that are relevant to your changes, and delete those that are not.

• I have followed the contribution guidelines for this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or modified tests that prove my changes work as intended
• I have verified that new and existing unit tests pass locally with my changes
• I have verified that my latest changes pass CI workflows for testing and linting
• I have made corresponding changes to the documentation